home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / gnustuff / tos / othergnu / texinf~1.zoo / texinfo.st / bin / texi2roff.man < prev    next >
Encoding:
Text File  |  1993-06-28  |  3.5 KB  |  97 lines
  1.  
  2. TEXI2ROFF(1)         ST Programmer's Manual         TEXI2ROFF(1)
  3.  
  4.  
  5.  
  6. NAME
  7.      texi2roff, texi2index - convert Texinfo documents for for-
  8.      matting by troff.
  9.  
  10. SYNOPSIS
  11.      texi2roff [ -me -mm -ms ] [ -iIt ] [ file ... ]
  12.      texi2index [ file ... ]
  13.  
  14. DESCRIPTION
  15.      Texi2roff translates the named files from the Texinfo macro
  16.      language for TeX to the language accepted by troff(1).
  17.      Files are read and processed in order.  If no file is given
  18.      or if the file is - texi2roff reads the standard input.
  19.  
  20.      Texi2index is a Bourne shell script which generates indices
  21.      for documents translated by texi2roff.
  22.  
  23. OPTIONS
  24.      Texi2roff
  25.  
  26.      -me -mm -ms
  27.           format the output for use with the troff macro package
  28.           named.
  29.  
  30.      -i   translate Texinfo index commands into troff index com-
  31.           mands.  troff will then emit index entries onto the
  32.           standard error output.  You may capture this output and
  33.           use texi2index(1) and troff to prepare indices from it.
  34.  
  35.      -I   include Texinfo ``Info file'' menu and node contents
  36.           and @ifinfo text in the output.  This material does not
  37.           appear in a Texinfo document formatted by TeX, but may
  38.           contain interesting information or be useful when
  39.           searching a machine-readable document.
  40.  
  41.      -t   (transparent) print text affected by otherwise dis-
  42.           carded commands, for people who are afraid of missing
  43.           something.  For best results use -It.
  44.  
  45. EXAMPLES
  46.      Translate doc.texinfo using the Bourne shell sh(1).  Format
  47.      with troff and -ms, placing the formatted output in doc,
  48.      index entries in index, and the formatted index in
  49.      doc.index.
  50.  
  51.      $ texi2roff -i -ms doc.texinfo | troff -ms > doc 2> index
  52.      $ texi2index index | troff -ms >doc.index
  53.  
  54.      As above, but use the C shell csh(1), nroff with -me, and
  55.      transparent mode:
  56.  
  57.      % (texi2roff -iIt -me doc.texinfo | nroff -me > doc ) >& index
  58.      % texi2index index | nroff -me >doc.index
  59.  
  60. DIAGNOSTICS
  61.      Errors are reported giving file name and line number.
  62.  
  63. AUTHOR
  64.      Beverly Erlebacher (erlebach@cs.toronto.edu).
  65.  
  66. BUGS
  67.      texi2roff does not track well all capabilities of texinfo
  68.      and some new commands may be not recognized.
  69.  
  70.      Some commented out constructs cause a total confusion of
  71.      texi2roff.  It is a good idea to use sed or awk to remove
  72.      all commented out lines before passing output to texi2roff.
  73.  
  74.      \f(CW is used to change to constant-width (typewriter-like)
  75.      font.  If this is not the standard at your site, run your
  76.      texi2roff output through sed(1) or edit texi2roff's transla-
  77.      tion tables.
  78.  
  79.      There are a number of differences in formatting details com-
  80.      pared to Texinfo.  Indentation is occasionally imperfect.
  81.  
  82.      @def commands do not generate index entries.
  83.  
  84.      Although Texinfo provides for a @contents and @summarycon-
  85.      tents Table of Contents, if both are specified only the
  86.      first one will appear if -ms is used.  To prevent loss of
  87.      detail, texi2roff generates the same Table of Contents for
  88.      both commands.
  89.  
  90.      The -mm macro package regards keeps as a type of display.
  91.      This can cause troff to abort in the case of a keep nested
  92.      in a display or vice versa.  Either use a different macro
  93.      package or remove a pair of Texinfo commands to eliminate
  94.      nesting.  Usually the @group...@end group is the best to
  95.      remove.
  96.  
  97.